Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update pyopenms as it seems to be compatible with numpy2 #51992

Merged
merged 8 commits into from
Nov 7, 2024

Conversation

hechth
Copy link
Contributor

@hechth hechth commented Nov 7, 2024

see here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

@hechth hechth mentioned this pull request Nov 7, 2024
Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Warning

Rate limit exceeded

@hechth has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 1056c83 and f86f615.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to two files related to the pyopenms package. In conda_build_config.yaml, the version specifications for the numpy dependency have been updated from specific versions (1.23.* and 1.26.*) to more flexible minimum version constraints (>=1.23.0 and >=1.26.0). This change allows for broader compatibility with newer numpy releases. In the meta.yaml file, the package version is set to "3.2.0", and the build number is incremented from 0 to 1, indicating a new build iteration. The source section is conditionally defined to point to either a Git repository or a specific tarball based on the version string. The requirements section lists dependencies with specific versions, and the test section includes a command to verify the installation of pyopenms. Additionally, the about section provides metadata about the package, including its homepage and license information.

Possibly related PRs

  • Update pyopenms to 3.2.0 #51753: This PR updates the pyopenms package to version 3.2.0, which includes changes to the meta.yaml file that directly relate to the updates made in the main PR regarding the numpy dependency version specifications.

Suggested labels

please review & merge

Suggested reviewers

  • bgruening
  • mencian

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
recipes/pyopenms/meta.yaml (2)

Line range hint 13-14: Hard-coded version in URL should be templated

The URL contains a hard-coded version 3.2.0. This should be templated using the version variable to avoid maintenance issues in future releases:

-  url: https://github.com/OpenMS/OpenMS/releases/download/release%2F3.2.0/OpenMS-3.2.tar.gz
+  url: https://github.com/OpenMS/OpenMS/releases/download/release%2F{{ version }}/OpenMS-{{ version.rsplit('.', 1)[0] }}.tar.gz

Line range hint 44-58: Document run_exports workaround more explicitly

The comment about run_exports bugs should be more specific to help future maintainers. Consider documenting:

  1. Which specific run_exports bugs are being worked around
  2. Link to relevant issue tracker entries
  3. Conditions under which this workaround can be removed
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a74801d and 1056c83.

📒 Files selected for processing (2)
  • recipes/pyopenms/conda_build_config.yaml (1 hunks)
  • recipes/pyopenms/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/pyopenms/conda_build_config.yaml

[error] 13-13: syntax error: expected chomping or indentation indicators, but found '='

(syntax)

🔇 Additional comments (4)
recipes/pyopenms/conda_build_config.yaml (1)

13-15: Verify numpy version compatibility matrix with Python versions

Please verify that the numpy version constraints are appropriate for each Python version in the matrix. Currently, Python 3.9-3.11 use >=1.23.0 while Python 3.12 uses >=1.26.0.

Let's check the numpy version requirements for different Python versions:

✅ Verification successful

Numpy version constraints are appropriate for Python versions

The numpy version constraints in the recipe are correctly configured:

  • Python 3.9-3.11: numpy >=1.23.0 (appropriate as these Python versions are compatible with numpy 1.23+)
  • Python 3.12: numpy >=1.26.0 (required as Python 3.12 support was added in numpy 1.26.0)

The configuration follows numpy's Python version compatibility matrix and ensures proper builds for each Python version.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify numpy version compatibility with Python versions
# Expected: Find any incompatibilities between numpy and Python versions

# Check if there are any other recipes using similar numpy/Python combinations
rg -l "numpy.*1\.2[36]" --type yaml $(fd -e yaml -e yml . recipes/)

# Look for potential numpy version constraints in build scripts
rg "numpy.*1\.2[36]" --type python $(fd -e py . recipes/)

Length of output: 365883


Script:

#!/bin/bash
# Let's check the numpy version compatibility with Python versions
# First, let's check if there are any specific Python version constraints in the recipe

cat recipes/pyopenms/conda_build_config.yaml

# Let's also check the meta.yaml for any additional context
cat recipes/pyopenms/meta.yaml

Length of output: 2526

🧰 Tools
🪛 yamllint

[error] 13-13: syntax error: expected chomping or indentation indicators, but found '='

(syntax)

recipes/pyopenms/meta.yaml (3)

20-23: Build configuration changes look good

The build number increment is appropriate for rebuilding with updated numpy compatibility. The run_exports section correctly pins the subpackage version for ABI compatibility.


Line range hint 59-62: Consider enhancing test coverage

The current test only verifies basic import functionality. The TODO comment about running the full test suite should be addressed:

  1. What prevents running the full test suite?
  2. What specific tests would be most valuable to include?

Would you like me to help create a more comprehensive test plan or open an issue to track this enhancement?


Line range hint 41-41: Verify numpy2 compatibility

Since this PR aims to update pyopenms for numpy2 compatibility:

  1. Ensure that the package has been tested with numpy2
  2. Consider documenting any known compatibility issues or limitations

Run the following to check for numpy version-specific code:

Also applies to: 53-53

Comment on lines 13 to 15
- >=1.23.0
- >=1.23.0
- >=1.26.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Critical: Avoid using >= constraints for numpy to prevent ABI compatibility issues

Using >= constraints for numpy versions is risky as it can lead to ABI compatibility issues. Numpy has strict ABI compatibility requirements, and it's recommended to pin to specific minor versions using the x.* syntax.

Apply this diff to maintain ABI compatibility:

numpy:
  - 1.23.*
-  - >=1.23.0
-  - >=1.23.0
-  - >=1.26.0
+  - 1.23.*
+  - 1.23.*
+  - 1.26.*

Reference: Numpy's binary compatibility policy recommends pinning to specific minor versions to ensure ABI compatibility.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- >=1.23.0
- >=1.23.0
- >=1.26.0
- 1.23.*
- 1.23.*
- 1.26.*
🧰 Tools
🪛 yamllint

[error] 13-13: syntax error: expected chomping or indentation indicators, but found '='

(syntax)

@hechth
Copy link
Contributor Author

hechth commented Nov 7, 2024

@timosachsenberg or @jpfeuffer can you confirm that numpy> 2 works fine with pyopenms?

@hechth hechth requested review from bgruening and jpfeuffer November 7, 2024 12:19
@jpfeuffer
Copy link
Contributor

In theory it is/always was (if a new enough numpy was used to build it) but it could be that the latest release still has an unnecessary hardcoded version limit in its setup.py.
I just recently fixed it.

@jpfeuffer
Copy link
Contributor

https://github.com/OpenMS/OpenMS/blob/release/3.2.0/src/pyOpenMS/setup.py#L257

I assume this will fail here:

$PYTHON -m pip install ./pyOpenMS/dist/*.whl --ignore-installed --no-deps

@jpfeuffer
Copy link
Contributor

jpfeuffer commented Nov 7, 2024

Oh, it did not. Ah yes, we use "ignore-installed" anyway, since there is no pip stuff. In that case, it should be fine. It barely has any numpy python code. Only a recent enough numpy C API was important for building.

@hechth
Copy link
Contributor Author

hechth commented Nov 7, 2024

@jpfeuffer thanks a lot for the explanation, that is nice! @bgruening can this then be merged?

@hechth hechth merged commit 259960e into master Nov 7, 2024
6 checks passed
@hechth hechth deleted the update_pyopenms branch November 7, 2024 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants